<?php
// $Id: RowIterator.interface.php 132 2007-02-12 04:19:37Z tswicegood $

/**
 * This file contains {@link RowIterator} which is part of the PHP Content 
 * Repository (phpCR), a derivative of the Java Content Repository JSR-170, and 
 * is licensed under the Apache License, Version 2.0.
 *
 * This file is based on the code created for
 * {@link http://www.jcp.org/en/jsr/detail?id=170 JSR-170}
 *
 * @author Travis Swicegood <development@domain51.com>
 * @copyright PHP Code Copyright &copy; 2004-2005, Domain51, United States
 * @copyright Original Java and Documentation 
 *    Copyright &copy; 2002-2004, Day Management AG, Switerland
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, 
 *    Version 2.0
 * @package phpContentRepository
 * @subpackage Query
 */


/**
 * Require the necessary file(s)
 */
require_once dirname(__FILE__) . '/../phpCR.library.php';
require_once PHPCR_PATH . '/query/Row.interface.php';
require_once PHPCR_PATH . '/RangeIterator.interface.php';
require_once PHPCR_PATH . '/exceptions/NoSuchElementException.exception.php';


/**
 * An Iterator containing the various {@link Row}s resulting from 
 * {@link QueryResult::getRows()}.
 *
 * @package phpContentRepository
 * @subpackage Query
 */
interface RowIterator extends RangeIterator 
{
	/**
	 * Returns the next {@link Row} in the iteration.
	 *
	 * @return object
	 *	A {@link Row} object
	 *
	 * @throws {@link NoSuchElementException}
	 *    If iteration has no more {@link Row}s.
	 */
	public function nextRow();
}

